<!DOCTYPE HTML>
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<main role="main">
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span><a id="line.1">/*</a>
<span class="sourceLineNo">002</span><a id="line.2"> * Licensed to the Apache Software Foundation (ASF) under one or more</a>
<span class="sourceLineNo">003</span><a id="line.3"> * contributor license agreements.  See the NOTICE file distributed with</a>
<span class="sourceLineNo">004</span><a id="line.4"> * this work for additional information regarding copyright ownership.</a>
<span class="sourceLineNo">005</span><a id="line.5"> * The ASF licenses this file to You under the Apache License, Version 2.0</a>
<span class="sourceLineNo">006</span><a id="line.6"> * (the "License"); you may not use this file except in compliance with</a>
<span class="sourceLineNo">007</span><a id="line.7"> * the License.  You may obtain a copy of the License at</a>
<span class="sourceLineNo">008</span><a id="line.8"> *</a>
<span class="sourceLineNo">009</span><a id="line.9"> *      http://www.apache.org/licenses/LICENSE-2.0</a>
<span class="sourceLineNo">010</span><a id="line.10"> *</a>
<span class="sourceLineNo">011</span><a id="line.11"> * Unless required by applicable law or agreed to in writing, software</a>
<span class="sourceLineNo">012</span><a id="line.12"> * distributed under the License is distributed on an "AS IS" BASIS,</a>
<span class="sourceLineNo">013</span><a id="line.13"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</a>
<span class="sourceLineNo">014</span><a id="line.14"> * See the License for the specific language governing permissions and</a>
<span class="sourceLineNo">015</span><a id="line.15"> * limitations under the License.</a>
<span class="sourceLineNo">016</span><a id="line.16"> */</a>
<span class="sourceLineNo">017</span><a id="line.17">package org.apache.commons.dbutils;</a>
<span class="sourceLineNo">018</span><a id="line.18"></a>
<span class="sourceLineNo">019</span><a id="line.19">import java.sql.ResultSet;</a>
<span class="sourceLineNo">020</span><a id="line.20">import java.sql.SQLException;</a>
<span class="sourceLineNo">021</span><a id="line.21">import java.util.Iterator;</a>
<span class="sourceLineNo">022</span><a id="line.22"></a>
<span class="sourceLineNo">023</span><a id="line.23">/**</a>
<span class="sourceLineNo">024</span><a id="line.24"> * &lt;p&gt;</a>
<span class="sourceLineNo">025</span><a id="line.25"> * Wraps a {@code ResultSet} in an {@code Iterator&amp;lt;Object[]&amp;gt;}.  This is useful</a>
<span class="sourceLineNo">026</span><a id="line.26"> * when you want to present a non-database application layer with domain</a>
<span class="sourceLineNo">027</span><a id="line.27"> * neutral data.</a>
<span class="sourceLineNo">028</span><a id="line.28"> * &lt;/p&gt;</a>
<span class="sourceLineNo">029</span><a id="line.29"> *</a>
<span class="sourceLineNo">030</span><a id="line.30"> * &lt;p&gt;</a>
<span class="sourceLineNo">031</span><a id="line.31"> * This implementation requires the {@code ResultSet.isLast()} method</a>
<span class="sourceLineNo">032</span><a id="line.32"> * to be implemented.</a>
<span class="sourceLineNo">033</span><a id="line.33"> * &lt;/p&gt;</a>
<span class="sourceLineNo">034</span><a id="line.34"> */</a>
<span class="sourceLineNo">035</span><a id="line.35">public class ResultSetIterator implements Iterator&lt;Object[]&gt; {</a>
<span class="sourceLineNo">036</span><a id="line.36"></a>
<span class="sourceLineNo">037</span><a id="line.37">    /**</a>
<span class="sourceLineNo">038</span><a id="line.38">     * The wrapped {@code ResultSet}.</a>
<span class="sourceLineNo">039</span><a id="line.39">     */</a>
<span class="sourceLineNo">040</span><a id="line.40">    private final ResultSet rs;</a>
<span class="sourceLineNo">041</span><a id="line.41"></a>
<span class="sourceLineNo">042</span><a id="line.42">    /**</a>
<span class="sourceLineNo">043</span><a id="line.43">     * The processor to use when converting a row into an Object[].</a>
<span class="sourceLineNo">044</span><a id="line.44">     */</a>
<span class="sourceLineNo">045</span><a id="line.45">    private final RowProcessor convert;</a>
<span class="sourceLineNo">046</span><a id="line.46"></a>
<span class="sourceLineNo">047</span><a id="line.47">    /**</a>
<span class="sourceLineNo">048</span><a id="line.48">     * Constructor for ResultSetIterator.</a>
<span class="sourceLineNo">049</span><a id="line.49">     * @param rs Wrap this {@code ResultSet} in an {@code Iterator}.</a>
<span class="sourceLineNo">050</span><a id="line.50">     */</a>
<span class="sourceLineNo">051</span><a id="line.51">    public ResultSetIterator(final ResultSet rs) {</a>
<span class="sourceLineNo">052</span><a id="line.52">        this(rs, new BasicRowProcessor());</a>
<span class="sourceLineNo">053</span><a id="line.53">    }</a>
<span class="sourceLineNo">054</span><a id="line.54"></a>
<span class="sourceLineNo">055</span><a id="line.55">    /**</a>
<span class="sourceLineNo">056</span><a id="line.56">     * Constructor for ResultSetIterator.</a>
<span class="sourceLineNo">057</span><a id="line.57">     * @param rs Wrap this {@code ResultSet} in an {@code Iterator}.</a>
<span class="sourceLineNo">058</span><a id="line.58">     * @param convert The processor to use when converting a row into an</a>
<span class="sourceLineNo">059</span><a id="line.59">     * {@code Object[]}.  Defaults to a</a>
<span class="sourceLineNo">060</span><a id="line.60">     * {@code BasicRowProcessor}.</a>
<span class="sourceLineNo">061</span><a id="line.61">     */</a>
<span class="sourceLineNo">062</span><a id="line.62">    public ResultSetIterator(final ResultSet rs, final RowProcessor convert) {</a>
<span class="sourceLineNo">063</span><a id="line.63">        this.rs = rs;</a>
<span class="sourceLineNo">064</span><a id="line.64">        this.convert = convert;</a>
<span class="sourceLineNo">065</span><a id="line.65">    }</a>
<span class="sourceLineNo">066</span><a id="line.66"></a>
<span class="sourceLineNo">067</span><a id="line.67">    /**</a>
<span class="sourceLineNo">068</span><a id="line.68">     * Returns true if there are more rows in the ResultSet.</a>
<span class="sourceLineNo">069</span><a id="line.69">     * @return boolean {@code true} if there are more rows</a>
<span class="sourceLineNo">070</span><a id="line.70">     * @throws RuntimeException if an SQLException occurs.</a>
<span class="sourceLineNo">071</span><a id="line.71">     */</a>
<span class="sourceLineNo">072</span><a id="line.72">    @Override</a>
<span class="sourceLineNo">073</span><a id="line.73">    public boolean hasNext() {</a>
<span class="sourceLineNo">074</span><a id="line.74">        try {</a>
<span class="sourceLineNo">075</span><a id="line.75">            return !rs.isLast();</a>
<span class="sourceLineNo">076</span><a id="line.76">        } catch (final SQLException e) {</a>
<span class="sourceLineNo">077</span><a id="line.77">            rethrow(e);</a>
<span class="sourceLineNo">078</span><a id="line.78">            return false;</a>
<span class="sourceLineNo">079</span><a id="line.79">        }</a>
<span class="sourceLineNo">080</span><a id="line.80">    }</a>
<span class="sourceLineNo">081</span><a id="line.81"></a>
<span class="sourceLineNo">082</span><a id="line.82">    /**</a>
<span class="sourceLineNo">083</span><a id="line.83">     * Returns the next row as an {@code Object[]}.</a>
<span class="sourceLineNo">084</span><a id="line.84">     * @return An {@code Object[]} with the same number of elements as</a>
<span class="sourceLineNo">085</span><a id="line.85">     * columns in the {@code ResultSet}.</a>
<span class="sourceLineNo">086</span><a id="line.86">     * @see java.util.Iterator#next()</a>
<span class="sourceLineNo">087</span><a id="line.87">     * @throws RuntimeException if an SQLException occurs.</a>
<span class="sourceLineNo">088</span><a id="line.88">     */</a>
<span class="sourceLineNo">089</span><a id="line.89">    @Override</a>
<span class="sourceLineNo">090</span><a id="line.90">    public Object[] next() {</a>
<span class="sourceLineNo">091</span><a id="line.91">        try {</a>
<span class="sourceLineNo">092</span><a id="line.92">            rs.next();</a>
<span class="sourceLineNo">093</span><a id="line.93">            return this.convert.toArray(rs);</a>
<span class="sourceLineNo">094</span><a id="line.94">        } catch (final SQLException e) {</a>
<span class="sourceLineNo">095</span><a id="line.95">            rethrow(e);</a>
<span class="sourceLineNo">096</span><a id="line.96">            return null;</a>
<span class="sourceLineNo">097</span><a id="line.97">        }</a>
<span class="sourceLineNo">098</span><a id="line.98">    }</a>
<span class="sourceLineNo">099</span><a id="line.99"></a>
<span class="sourceLineNo">100</span><a id="line.100">    /**</a>
<span class="sourceLineNo">101</span><a id="line.101">     * Deletes the current row from the {@code ResultSet}.</a>
<span class="sourceLineNo">102</span><a id="line.102">     * @see java.util.Iterator#remove()</a>
<span class="sourceLineNo">103</span><a id="line.103">     * @throws RuntimeException if an SQLException occurs.</a>
<span class="sourceLineNo">104</span><a id="line.104">     */</a>
<span class="sourceLineNo">105</span><a id="line.105">    @Override</a>
<span class="sourceLineNo">106</span><a id="line.106">    public void remove() {</a>
<span class="sourceLineNo">107</span><a id="line.107">        try {</a>
<span class="sourceLineNo">108</span><a id="line.108">            this.rs.deleteRow();</a>
<span class="sourceLineNo">109</span><a id="line.109">        } catch (final SQLException e) {</a>
<span class="sourceLineNo">110</span><a id="line.110">            rethrow(e);</a>
<span class="sourceLineNo">111</span><a id="line.111">        }</a>
<span class="sourceLineNo">112</span><a id="line.112">    }</a>
<span class="sourceLineNo">113</span><a id="line.113"></a>
<span class="sourceLineNo">114</span><a id="line.114">    /**</a>
<span class="sourceLineNo">115</span><a id="line.115">     * Rethrow the SQLException as a RuntimeException.  This implementation</a>
<span class="sourceLineNo">116</span><a id="line.116">     * creates a new RuntimeException with the SQLException's error message.</a>
<span class="sourceLineNo">117</span><a id="line.117">     * @param e SQLException to rethrow</a>
<span class="sourceLineNo">118</span><a id="line.118">     * @since DbUtils 1.1</a>
<span class="sourceLineNo">119</span><a id="line.119">     */</a>
<span class="sourceLineNo">120</span><a id="line.120">    protected void rethrow(final SQLException e) {</a>
<span class="sourceLineNo">121</span><a id="line.121">        throw new RuntimeException(e.getMessage());</a>
<span class="sourceLineNo">122</span><a id="line.122">    }</a>
<span class="sourceLineNo">123</span><a id="line.123"></a>
<span class="sourceLineNo">124</span><a id="line.124">    /**</a>
<span class="sourceLineNo">125</span><a id="line.125">     * Generates an {@code Iterable}, suitable for use in for-each loops.</a>
<span class="sourceLineNo">126</span><a id="line.126">     *</a>
<span class="sourceLineNo">127</span><a id="line.127">     * @param rs Wrap this {@code ResultSet} in an {@code Iterator}.</a>
<span class="sourceLineNo">128</span><a id="line.128">     * @return an {@code Iterable}, suitable for use in for-each loops.</a>
<span class="sourceLineNo">129</span><a id="line.129">     */</a>
<span class="sourceLineNo">130</span><a id="line.130">    public static Iterable&lt;Object[]&gt; iterable(final ResultSet rs) {</a>
<span class="sourceLineNo">131</span><a id="line.131">        return new Iterable&lt;Object[]&gt;() {</a>
<span class="sourceLineNo">132</span><a id="line.132"></a>
<span class="sourceLineNo">133</span><a id="line.133">            @Override</a>
<span class="sourceLineNo">134</span><a id="line.134">            public Iterator&lt;Object[]&gt; iterator() {</a>
<span class="sourceLineNo">135</span><a id="line.135">                return new ResultSetIterator(rs);</a>
<span class="sourceLineNo">136</span><a id="line.136">            }</a>
<span class="sourceLineNo">137</span><a id="line.137"></a>
<span class="sourceLineNo">138</span><a id="line.138">        };</a>
<span class="sourceLineNo">139</span><a id="line.139">    }</a>
<span class="sourceLineNo">140</span><a id="line.140"></a>
<span class="sourceLineNo">141</span><a id="line.141">}</a>




























































</pre>
</div>
</main>
</body>
</html>
